/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * <http://www.mongodb.com/licensing/server-side-public-license>.
 */
package org.graylog2.plugin.lookup;

/**
 * This is passed into {@link LookupDataAdapter#doRefresh(LookupCachePurge)} to allow data adapters to prune cache
 * entries without having to know about the actual cache instances.
 */
public interface LookupCachePurge {
    /**
     * Purges all entries from the cache.
     */
    void purgeAll();

    /**
     * Purges only the cache entry for the given key.
     * @param key cache key to purge
     */
    void purgeKey(Object key);
}
